Ktor OpenAPI/Swagger 3 Generator/com.papsign.ktor.openapigen

Package-level declarations

Types

interface APIException<EX : Throwable, B>

interface APITag

This interface is used to define tags to classify endpoints. It needs to be implemented using an enum so that the processor properly detects equality.

HashSchemaMap

typealias HashSchemaMap = HashMap<KType, SchemaModel<*>>

KTypeProperty

data class KTypeProperty(val name: String, val type: KType, val source: KProperty1<*, *>)

LinkedHashSchemaMap

typealias LinkedHashSchemaMap = LinkedHashMap<KType, SchemaModel<*>>

MutableSchemaMap

typealias MutableSchemaMap = MutableMap<KType, SchemaModel<*>>

OpenAPIGen

class OpenAPIGen(config: OpenAPIGen.Configuration, val pipeline: ApplicationCallPipeline)

OpenAPIGenExtension

interface OpenAPIGenExtension

OpenAPIGenModuleExtension

interface OpenAPIGenModuleExtension : OpenAPIModule, OpenAPIGenExtension

implement this to automatically register an object as OpenAPIModule in the global context only works if the object is in a package declared in OpenAPIGen.Configuration.scanPackagesForModules

SchemaMap